JavaScript

{dialog.object}synchronizeEmbeddedUX Method

Syntax

{dialog.Object}.synchronizeEmbeddedUX(UX_EmbeddedUXAlias)

Arguments

UX_EmbeddedUXAlias: Alias of the embedded UX component.

Description

Synchronizes an embedded UX component.

Discussion

Typically, the embedded UX component will have arguments that are bound to controls on the parent UX component. When one of these controls in the parent UX changes, you can use this method to automatically recompute the data shown in certain controls (such as Lists and controls that are based on Data Series). In addition, the client-side 'onSynchronizeDialog' and server-side 'onSynchronize' events on the embedded UX component will fire, allowing you to write code that refreshes other aspects of the embedded UX based on new values for UX component's arguments.

Example

//Refresh the embedded UX component with an alias of 'UXCHILD1'
{dialog.Object}.synchronizeEmbeddedUX('UXCHILD1');

You must give the embedded UX an explicit alias name. You cannot use the default <DefaultAlias> value for the alias.